home *** CD-ROM | disk | FTP | other *** search
/ Qoole for Quake / Qoole for Quake (USA) / Qoole for Quake (USA).bin / Tutorial / HTML / QUBE.ZIP / README.TXT < prev    next >
Encoding:
Text File  |  1996-11-05  |  10.4 KB  |  274 lines
  1.  
  2. ABOUT NEW QBSP, LIGHT, AND VIS
  3. ------------------------------
  4.  
  5. Well, for whatever it's worth, here they are:  My updated versions of
  6. QBSP, Vis, and Light.  I like to do level creation with these tools,
  7. but Carmack's versions (I felt) left a lot to be desired, so I added
  8. useful things where I saw appropriate.    For the most part, the docs
  9. included in "readme.id" are still applicable, but there are some
  10. changes:
  11.  
  12.     * Each program dumps out a hell of a lot more information.
  13.       So much, in fact, that it can sometimes be hard to follow
  14.       as it goes flying by.
  15.  
  16.     * Output is now logged automatically.  If your map file is
  17.       myfile.map, the BSP file is myfile.bsp and the log file
  18.       is myfile.log.
  19.  
  20.     * Error messages automatically display in bright red so that
  21.       it's easy to see when you goofed up.
  22.  
  23.     * "path_corner" classes are now ignored in QBSP when filling
  24.       the outside.    This used to be an erroneous error of the old
  25.       QBSP, often generated by having "func_train" objects which
  26.       move in and out of walls.
  27.  
  28.     * Each program tries to time-log itself visually with a bar
  29.       displaying percentage of time to go.    The bar in QBSP only
  30.       displays how much time is left in the current calculation.
  31.  
  32.     * Each program tries to show how much memory is being used.
  33.       This is displayed to the right of the elapsed time.
  34.  
  35.     * Elapsed time is updated by the internal routines of each
  36.       program.  If the elapsed time stops counting, that is an
  37.       indication that the program may have stopped running.
  38.  
  39.     * Each program automatically displays information about the
  40.       BSP file on the right side of the screen, so you don't need
  41.       to run bspinfo to find it out.
  42.  
  43.  
  44. INSTALLING
  45. ----------
  46.  
  47. You should have received the whole package as a single .ZIP file.  If
  48. not, you should download a reliable copy from ftp.cdrom.com.  Unzip the
  49. .ZIP file to some directory (I prefer Q:/PROG/QBSP, but your mileage may
  50. vary) making sure that you allow directories to be created as well
  51. (in PKUNZIP that means using the -d flag).  You should have these files:
  52.  
  53.     LIGHT.EXE        The new version of Light
  54.     QBSP.EXE        The new version of QBSP
  55.     VIS.EXE         The new version of Vis
  56.     GO32.EXE        The DJGPP DOS extender
  57.     README.id        id Software's original README
  58.     README.LIN        The Linux README
  59.     README.TXT        This file
  60.     SRC/*            Source code for the three programs
  61.  
  62. You should be able to use the programs simply by executing them from
  63. their directory.  I recommend, however, that you put them in a directory
  64. accessable from your PATH, since it makes using them easier.  If you
  65. do, you will need to put GO32.EXE into the same directory as the other
  66. three tools since they depend on it.  (I have a C:\UTIL directory which
  67. is in my PATH and contains useful utilities and tools; that is where I
  68. keep these programs.)
  69.  
  70. The QBSP options for -l, -v, and their variants will not work unless
  71. the three programs (and GO32) are in your PATH.
  72.  
  73. FOR THOSE WITH DJGPP INSTALLED:  The version of GO32.EXE included in
  74. this package is somewhat old, so it may be incompatible with your
  75. existing version.  However, if you have newer versions of GO32.EXE
  76. and DJGPP, you can use those to run the three programs instead.  The
  77. .EXE files are all made by COFF2EXE; presumably you can use EXE2COFF
  78. to generate COFF files if you need them for some reason.
  79.  
  80.  
  81. NEW OPTIONS 
  82. -----------
  83.  
  84. QBSP has several new options, as does Light.  All three programs have
  85. had the -threads option removed because most people don't own a
  86. multiprocessor system; if you want a multithreaded version, you'd better
  87. use Carmack's.
  88.  
  89. Equally useful is that all three programs have rebuilt command-line
  90. info which displays the options with a lot of extra useless information.
  91. Just type the program name by itself on the command-line to see the
  92. information.
  93.  
  94. QBSP's new options are:
  95.  
  96.     -v    Will run Vis on the file, assuming QBSP runs successfully.
  97.         This is standard, slow, O(n^5) Vis-ing.
  98.  
  99.     -vf    Will run Vis "-fast" on the file, assuming QBSP runs
  100.         successfully.  This is much faster than Vis usually is,
  101.         but is often less accurate (i.e., produces a much slower
  102.         level).
  103.  
  104.     -l    Will run Light on the file, assuming QBSP runs successfully.
  105.  
  106.     -e    The quick way to say "-onlyents" to QBSP.
  107.  
  108.     -el    Updates only entities and then runs Light.
  109.  
  110.         -lv     Will run Light and Vis on the file, assuming QBSP runs
  111.         successfully.  If QBSP fails, neither Light nor Vis will run.
  112.         If Light fails, Vis will not be run.
  113.  
  114.     -lvf    Like "-lv", only uses the "-fast" option with Vis.
  115.  
  116. Light's new options are:
  117.  
  118.     -v    Will run Vis on the file, assuming Light runs successfully.
  119.  
  120.     -vf    Will run Vis "-fast" on the file, assuming Light runs
  121.         successfully.
  122.  
  123.  
  124. DISCLAIMER
  125. ----------
  126.  
  127. While these versions may not be useful to everyone, I certainly do find
  128. them useful.  Or, more accurately, I do not put a warranty of any kind
  129. on these programs:  If they fail, or if they eat your hard drive, or do
  130. some other destructive thing, do not come whining to me; it's not my
  131. problem:  You were the one who ran them.  To be blunt:
  132.  
  133.     <WARRANTY>
  134.         THERE IS NO WARRANTY, EXPRESSED OR IMPLIED, ON THESE
  135.     VERSIONS OF QBSP, LIGHT, OR VIS.
  136.     </WARRANTY>
  137.  
  138. I do not claim to understand what the heck is going on in these programs.
  139. I have a pretty good idea of what's going on, but I fully intend to keep
  140. it to myself, so don't bother e-mailing me about how to use them:  E-mail
  141. about these programs will probably receive a *thunk* into the nearest
  142. /dev/null.  If you want to know what's going on, either pray that Carmack
  143. will answer your e-mail, or better yet, post your stupid questions to
  144. rec.computer.games.quake.editing or the Quake Developer's Mailing List.
  145.  
  146. If you have brilliant ideas about how these programs could be made better,
  147. you're welcome to send them, but bear in mind that I probably have better
  148. things to do than read funky ideas, so I may *thunk* those as well.  And,
  149. no, I don't plan to speed up Vis, either.  I have a team of mathematicians
  150. working on it, but until they sit down and start coding, Vis will run just
  151. as fast as it always has.
  152.  
  153.  
  154. TECHNICAL INFO
  155. --------------
  156.  
  157. The output stuffs use a general-purpose I/O library I hacked up for the
  158. task.  It is in two halves, the ultra-general-purpose library in curs.c
  159. and curs.h, and the QBSP/Light/Vis -specific part in scrn.c.  I stuck
  160. with Carmack-style formatting as much as I could stomach it, but beware
  161. that I probably reformatted some stuff in places for my personal ease of
  162. use.
  163.  
  164. The curs.c file is the only part specific to the PC architecture.  Replace
  165. it and this will run on anything, just like before.  I plan to build a
  166. UNIX/ANSI version of this just as soon as I can get around to it.
  167. I don't plan to do a Windows 3.1/95/NT version, *ever*.  If
  168. you want a Windows-capable version, you're more than welcome to do the
  169. nasty work yourself.  You won't find me degenerating to that $#!&.
  170. All of the output should no longer be using printf with the exception
  171. of the initial command-line-usage-output stuff, so if you *really* want
  172. a windowed version, it shouldn't be too hard to write.
  173.  
  174. I took out -threads because I don't own a multiprocessor system and
  175. multiprocessing code doesn't lend itself too well to this kind of output
  176. anyway.  If you want -threads back, #if 1 the command-line switches and
  177. rebuild the curs.c and scrn.c code as necessary with mutexes around those
  178. functions you think might need to be reentrant.
  179.  
  180. The Makefile is completely different.  The old one didn't like my system
  181. much, so I rebuilt it.    The bspinfo and entmap programs are not included
  182. in this; if you want those, get Carmack's original qbsp.tar.gz from some
  183. public ftp site.  I don't quite know what they're supposed to do, haven't
  184. asked on the Net, and really don't care: I don't use them, so they're not
  185. here.
  186.  
  187. All of the source to QBSP, Light, and Vis should be in here, so if you
  188. want to modify anything, go right ahead.
  189.  
  190. I have included working DOS executables and the version of GO32.EXE that
  191. I am using.  You should be able to get these tools running with that.  I
  192. don't recommend running these programs in Windows 3.1/95/NT; while they'll
  193. probably run, they'll probably run very poorly since they have significantly
  194. less memory to work in than they would on a vanilla-DOS system.
  195.  
  196.  
  197. COMMON QUESTIONS
  198. ----------------
  199.  
  200. Q: Where are the rest of the tools?
  201. A: Not ready for release yet.  They are due; just wait a few weeks.
  202.  
  203. Q: I have a question:  Can I e-mail you?
  204. A: Sure.  Just don't expect a response most of the time.
  205.  
  206. Q: Where's the Windows version?
  207. A: Don't ask me.  I'm not writing it.
  208.  
  209. Q: Can I put these programs on a CD and sell them?
  210. A: Whatever rules id put on the original versions apply to these.  If
  211.    you want to know if you can sell it, ask them, since a lot of this
  212.    is still their code.
  213.  
  214.  
  215. RELEASE LOG
  216. -----------
  217.  
  218. November 5, 1996        Initial release of the new tools.
  219.  
  220.  
  221. BUGS
  222. ----
  223.  
  224.     * Everything is too slow.  But since my algorithmic skills aren't
  225.       up to par to rebuild Carmack's code, this fix will have to wait.
  226.  
  227.     * Output is cryptic.  Beginning users won't understand half that
  228.       stuff flashing at them.
  229.  
  230.     * Log files are too cryptic.
  231.  
  232.     * Multithreading is not supported.
  233.  
  234.     * The source code is nearly unreadable.
  235.  
  236.     * QBSP eats too much memory and should probably be split up.
  237.  
  238.     * The CSG4 stage of QBSP seems to barf on really big levels on
  239.       small systems.  This may be memory related, though.
  240.  
  241.         * Doesn't support ANSI or VT100 output, which makes it unusable in
  242.       UNIX.  This is probably the next fix coming.
  243.  
  244.     * Needs a friendlier startup interface, possibly with menus to
  245.       simplify things.  The command-line args are useful but very
  246.       cryptic.
  247.  
  248.     * Ought to be able to have configuration files for things like
  249.       project directory and such.  Ought to support multiple project
  250.       directories too.
  251.  
  252.     * It would be nice if these could intelligently decide what to
  253.       update from .MAP to .BSP.   { editor's note:  This may never
  254.                     get done, but it's a fun thought,
  255.                     isn't it? }
  256.  
  257.  
  258. SPECIAL THANKS
  259. --------------
  260.     John Carmack      For writing these tools in the first place
  261.     id Software      For making the coolest games in the Milky Way
  262.     set@netcom.com      For converting the original versions for use in GCC
  263.     D.J. Delorie      For making GCC run in MS-DOG
  264.     Michael Abrash      For leaving Microsoft and joining id
  265.     Senator Exon      For not noticing Quake yet :)
  266.  
  267.  
  268.  
  269.  
  270.                 --- Sean Werkema
  271.                     stw113@psu.edu
  272.                     November 5, 1996
  273.  
  274.